Skip to content

OPS-39709: document PrepaidOrVcc billing automation prepayment value - #74

Merged
jnv merged 8 commits into
mainfrom
ops-39709-document-prepaid-or-vcc
Aug 12, 2026
Merged

OPS-39709: document PrepaidOrVcc billing automation prepayment value#74
jnv merged 8 commits into
mainfrom
ops-39709-document-prepaid-or-vcc

Conversation

@Mazaher-Bazari

@Mazaher-Bazari Mazaher-Bazari commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Summary

OPS-39709: PrepaidOrVcc was added to RoutingRulePrepayment in mews#86308 but left out of the Connector API contract, so a billing automation holding the value made billingAutomations/getAll throw for the whole enterprise. mews#86733 closes that gap and ships with the Tuesday 11 August 2026 release. This PR documents the new value: the changelog entry, and the Billing automation prepayment type enum on the billing automations reference page.

Important

Do not merge before Tuesday 11 August 2026. Until mews#86733 ships, this documents PrepaidOrVcc as an accepted request value that the API still rejects.

Checklist

  • Documentation follows the contribution guidelines
  • Changelog accurately describes all changes
  • All hyperlinks tested
  • SUMMARY.md updated if new pages added — n/a, no new pages

API

  • Changelog highlights the affected endpoints or operations
  • Changelog highlights any deprecations — n/a, additive change only
  • Deprecation Table updated if any deprecations — n/a, nothing deprecated

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Mazaher-Bazari
Mazaher-Bazari requested a review from a team as a code owner August 5, 2026 14:20
@moxly

moxly commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Review posted. View review · run

@Mazaher-Bazari Mazaher-Bazari self-assigned this Aug 5, 2026
@Mazaher-Bazari
Mazaher-Bazari marked this pull request as draft August 5, 2026 14:25

@moxly moxly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk Assessment

Score: 2/10 — low

Documentation-only change to a docs repository — no runtime code, so there is no direct production-incident path. The residual risk is integrator-facing and modest: the docs publish PrepaidOrVcc as an accepted request value before the contract change (mews#86733) has shipped, and the hand-written descriptions live in a generated file that the next regeneration reverts.

Review Summary

Verdict: COMMENT

2 warnings, 2 nits.

The changelog entry matches repository conventions closely: single {% updates format="full" %} wrapper, one {% update %} block, level-2 heading, three operation bullets followed by one shared detail bullet (CONTRIBUTING.md:118-127), and the additive-enum wording mirrors the existing Counter type discriminator entry at line 31. All four anchors resolve (#get-all-billing-automations → line 4, #add-billing-automations → line 221, #update-billing-automations → line 377, #billing-automation-prepayment-type → line 150). No **Breaking:** / **Deprecated** label is needed, so the deprecations table correctly stays untouched. The PR body's three claims — enum value added, the three Prepayment objects annotated, changelog entry added — are all present in the diff.

The PR template is fully filled in, with n/a rationale on the non-applicable checklist items. Both self-flagged reviewer notes are real and are addressed in the inline comments below.

I checked whether the sibling Applicability enum in routingrules.md:118-121 needed the same treatment — its values are Always / PrepaidOnly, a different contract enum, so it is correctly out of scope.

Fix All — prompt for AI agent

Fix the following issues in this PR:

  1. In connector-api/operations/billingautomations.md (lines 152-154, plus the property rows at 124, 287, 429): these descriptions are hand-written into a generated file (<!-- AUTOMATICALLY GENERATED, DO NOT MODIFY -->, and _generator reads descriptions straight from the upstream swagger with no local override), so the next regeneration reverts them. Extend the mews#86733 follow-up to cover both the enum [Description] attributes on BillingAutomationPrepayment and the Prepayment property descriptions on BillingAutomation, BillingAutomationAddParameters, and BillingAutomationUpdateParameters — otherwise the property-row sentences vanish entirely and the enum bullets regress to PrepaidOrVcc - PrepaidOrVcc.
  2. In connector-api/changelog/README.md (line 4): move the {% update date %} to the mews#86733 release date and hold the merge until that contract change ships. Until then, Add billing automations and Update billing automations document PrepaidOrVcc as an accepted request value that the API will reject.
  3. In connector-api/changelog/README.md (line 11): optionally add a detail bullet for the All / Prepaid description clarifications ending Documentation-only, no change to API. per CONTRIBUTING.md:134.
  4. In connector-api/operations/billingautomations.md (line 153): expand OTA on first use in the page (online travel agency (OTA)), matching routingrules.md:342 — best done in the upstream mews#86733 wording.

After all changes, run the project's linter/formatter.

Comment thread connector-api/operations/billingautomations.md Outdated
Comment thread connector-api/changelog/README.md Outdated
Comment thread connector-api/changelog/README.md
Comment thread connector-api/operations/billingautomations.md Outdated
@moxly moxly added the risk: low label Aug 5, 2026
Mazaher-Bazari and others added 2 commits August 6, 2026 10:51
Addresses PR #74 review: the entry covered the enum extension but not
the description clarifications the same change makes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Addresses PR #74 review: the entry must not publish PrepaidOrVcc as an
accepted request value before the contract change ships.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Mazaher-Bazari
Mazaher-Bazari marked this pull request as ready for review August 6, 2026 08:58
@moxly

moxly commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Review posted. View review · run

@moxly moxly left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk Assessment

Score: 1/10 — low

Documentation-only change in a docs repository, and the one integrator-facing risk from the previous round — publishing PrepaidOrVcc as an accepted request value ahead of the contract change — is now closed by moving the entry to the mews#86733 release date (2026-08-11, a Tuesday, matching the PR's hold note) and keeping the PR in draft until that ships.

Review Summary

Verdict: APPROVE

Re-review scoped to changes since commit 9b8cb57 — no new issues.

4 prior findings resolved — 2 fixed, 2 dismissed; 0 carried forward. The changelog date now sits in the future per CONTRIBUTING.md:141, and the added detail bullet at connector-api/changelog/README.md:12 accurately covers the Prepayment property and All / Prepaid value clarifications, ending with the required Documentation-only, no change to API. per CONTRIBUTING.md:134. I verified the generator trace behind the dismissed regeneration finding: propertyDescription returns firstLine(description) only for enum schemas (_generator/jsonschema.js:101-106, _generator/utils.js:25-27) and the full trimmed description otherwise, so the single-line property-row sentences survive as the author described — the follow-up correctly stays scoped to the BillingAutomationPrepayment [Description] attributes. The OTA-expansion nit is likewise accepted as belonging in the upstream mews#86733 wording.

Mazaher-Bazari and others added 3 commits August 6, 2026 11:33
…butes

The enum descriptions were added upstream, so the hand-written bullets
now mirror the spec verbatim and regeneration after the release is a
no-op instead of a reworded diff.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…86733

The three [SwaggerSchema] changes on BillingAutomation,
BillingAutomationAddParameters and BillingAutomationUpdateParameters were
taken out of the contract PR, so the rows documenting them described text
the spec will never contain. Only the enum block remains, which matches
the [Description] attributes verbatim.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
billingautomations.md is generated from the production swagger, so the
enum block lands on its own in the regeneration that follows the
mews#86733 release. Hand-editing it here only risked drift.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Mazaher-Bazari Mazaher-Bazari changed the title OPS-39709: document PrepaidOrVcc billing automation prepayment value OPS-39709: changelog entry for PrepaidOrVcc billing automation prepayment value Aug 6, 2026
Regeneration is manual, so a changelog-only PR would merge announcing the
value while the reference page still showed the old enum. Output of
_generator run against the mews#86733 build; to be re-verified against
production after the release before merge.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@Mazaher-Bazari Mazaher-Bazari changed the title OPS-39709: changelog entry for PrepaidOrVcc billing automation prepayment value OPS-39709: document PrepaidOrVcc billing automation prepayment value Aug 6, 2026
@jnv
jnv merged commit bb9de86 into main Aug 12, 2026
10 checks passed
@jnv
jnv deleted the ops-39709-document-prepaid-or-vcc branch August 12, 2026 11:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants